Skip to main content
Minh Nong
💬
0 discussions

[API] api-service

API Endpoints​

Response​

  • 200: Success
  • 403: Forbidden
  • 400: Bad Request

Auth​

  • Auth Type : Bearer Token

runner.js​

Post endpoint​

  • Route: /:endpoint_id
  • Method: POST
  • Params: endpoint_id
  • Body: req.body
  • Related API:
    • client: GET /api/key/${id}
    • client: GET /api/endpoint/${req.params.endpoint_id}
  • Return Format:
    • Success: 200 res.json(resp.data)
    • Failure: 400 { success: false, error: { message: error } }

endpoint.js​

Get Endpoint​

  • Route: /endpoint
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/key/${id}
  • Return Format:
    • Success: 200 res.render('endpoint', { session: req.session.user, result: list })
    • Failure: 400 { success: false, error: err.message }

Update Endpoint​

  • Route: /endpoint/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: GET /api/${versionApi}/key/${id}
    • Access: GET /api/${versionApi}/endpoint/${req.params.id}
    • Access: PUT /api/${versionApi}/endpoint/${req.params.id}
  • Return Format:
    • Success: 200 res.json({ success: true })
    • Failure: 400 { success: false, error: err.message }

key.js​

Key​

  • Route: /key
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/email/${user.email}/info
    • Access: GET /api/${versionApi}/callcenter/${user.domain}/agents/all
  • Return Format:
    • Success: 200 res.render('key', result)
    • Failure: 400 { success: false, error: err.message }

Create Key​

  • Route: /key
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/email/${user.email}/info
    • Access: GET /api/${versionApi}/callcenter/${user.domain}/agents/all
    • Access: POST /api/${versionApi}/key
  • Return Format:
    • Success: 200 res.json({ success: true, result: resp.data })
    • Failure: 400 { success: false, error: err }

Update Key​

  • Route: /key/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/key/${id}
  • Return Format:
    • Success: 200 res.json({ success: true, result: resp })
    • Failure: 400 { success: false, error: err.message }

Delete Key​

  • Route: /key/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: DELETE /api/${versionApi}/key/${id}
  • Return Format:
    • Success: 200 res.json({ success: true })
    • Failure: 400 { success: false, error: err.message }